feat: Add OpenAPI docs plugin with auto-generated API reference#25
Merged
druid-infra merged 5 commits intomasterfrom Feb 10, 2026
Merged
feat: Add OpenAPI docs plugin with auto-generated API reference#25druid-infra merged 5 commits intomasterfrom
druid-infra merged 5 commits intomasterfrom
Conversation
- Upgrade Docusaurus from 3.2.1 to 3.9.2 - Install docusaurus-plugin-openapi-docs v4.7.1 - Install docusaurus-theme-openapi-docs v4.7.1 - Add openapi.yaml from druid-cli repository - Configure plugin to generate docs in docs/cli/ - Add API link to navbar - Generate 80+ API endpoint pages from OpenAPI spec - Group endpoints by tag (scroll, logs, metrics, process, coldstarter, etc.) - Add docItemComponent configuration for ApiItem theme - Set slug for druid-cli.info.mdx to /cli for proper routing - Update deps: React 18.3.1, TypeScript 5.9.3, clsx 2.1.1 The API docs are now automatically generated from the OpenAPI spec and will stay in sync with druid-cli changes. Run 'bun run gen-api-docs' to regenerate docs when openapi.yaml is updated.
Contributor
Author
|
Contributor
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 79e3c7e | Commit Preview URL Branch Preview URL |
Feb 10 2026, 12:59 PM |
added 4 commits
February 10, 2026 13:36
- Add scripts/fetch-openapi.sh to download latest openapi.yaml from druid-cli - Update gen-api-docs script to fetch before generating - Add openapi.yaml to .gitignore (no longer tracked in repo) - Ensure docs are always in sync with latest druid-cli master - Prevents stale API documentation Usage: bun run gen-api-docs This will automatically fetch the latest spec and regenerate docs.
- Update docs/cli/_category_.json with 'API Reference' label - Set position to 100 (end of sidebar) - Set collapsed to false (expanded by default) - Add category link to druid-cli intro page - Improves navigation and organization of API documentation
- Move OpenAPI generated docs from docs/cli/ to docs/cli/api/ - Update plugin config outputDir to docs/cli/api - Create docs/cli/api/_category_.json (API Reference subcategory) - Set position to 3 (after Commands subcategory) - Update navbar link from /cli to /cli/api - Set slug /cli/api on druid-cli.info.mdx Result: API Reference is now a subcategory inside Druid CLI, alongside Commands, matching the desired documentation structure. Directory structure: - Druid CLI/ - Introduction, Available Scrolls, Plugins, Scroll - Commands/ (existing) - API Reference/ (new - all OpenAPI endpoints)
- Set Commands position to 100 - Set API Reference position to 101 - Both subcategories now appear at the end of Druid CLI navigation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements automatic API documentation generation from the druid-cli OpenAPI spec.
Changes
Features
bun run gen-api-docsto regenerate when openapi.yaml changesBuild Status
✅ Build passes successfully with only non-critical warnings (blog truncation, pre-existing German translation anchors)
Preview
After merge, API docs will be available at: https://docs.druid.gg/cli
Related
Testing
bun install bun run build bun run serve # Visit http://localhost:3000/cli